<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.smtp;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/***<a name="line.20"></a>
<span class="sourceLineNo">021</span> * This class is used to construct a bare minimum<a name="line.21"></a>
<span class="sourceLineNo">022</span> * acceptable header for an email message.  To construct more<a name="line.22"></a>
<span class="sourceLineNo">023</span> * complicated headers you should refer to RFC 822.  When the<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Java Mail API is finalized, you will be<a name="line.24"></a>
<span class="sourceLineNo">025</span> * able to use it to compose fully compliant Internet text messages.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * The main purpose of the class is to faciliatate the mail sending<a name="line.27"></a>
<span class="sourceLineNo">028</span> * process, by relieving the programmer from having to explicitly format<a name="line.28"></a>
<span class="sourceLineNo">029</span> * a simple message header.  For example:<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;pre&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * writer = client.sendMessageData();<a name="line.31"></a>
<span class="sourceLineNo">032</span> * if(writer == null) // failure<a name="line.32"></a>
<span class="sourceLineNo">033</span> *   return false;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * header =<a name="line.34"></a>
<span class="sourceLineNo">035</span> *    new SimpleSMTPHeader("foobar@foo.com", "foo@bar.com" "Just testing");<a name="line.35"></a>
<span class="sourceLineNo">036</span> * header.addCC("bar@foo.com");<a name="line.36"></a>
<span class="sourceLineNo">037</span> * header.addHeaderField("Organization", "Foobar, Inc.");<a name="line.37"></a>
<span class="sourceLineNo">038</span> * writer.write(header.toString());<a name="line.38"></a>
<span class="sourceLineNo">039</span> * writer.write("This is just a test");<a name="line.39"></a>
<span class="sourceLineNo">040</span> * writer.close();<a name="line.40"></a>
<span class="sourceLineNo">041</span> * if(!client.completePendingCommand()) // failure<a name="line.41"></a>
<span class="sourceLineNo">042</span> *   return false;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;/pre&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @see SMTPClient<a name="line.46"></a>
<span class="sourceLineNo">047</span> ***/<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>public class SimpleSMTPHeader<a name="line.49"></a>
<span class="sourceLineNo">050</span>{<a name="line.50"></a>
<span class="sourceLineNo">051</span>    private final String __subject, __from, __to;<a name="line.51"></a>
<span class="sourceLineNo">052</span>    private final StringBuffer __headerFields;<a name="line.52"></a>
<span class="sourceLineNo">053</span>    private StringBuffer __cc;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /***<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * Creates a new SimpleSMTPHeader instance initialized with the given<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * from, to, and subject header field values.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * &lt;p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @param from  The value of the &lt;code&gt;From:&lt;/code&gt; header field.  This<a name="line.59"></a>
<span class="sourceLineNo">060</span>     *              should be the sender's email address.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @param to    The value of the &lt;code&gt;To:&lt;/code&gt; header field.  This<a name="line.61"></a>
<span class="sourceLineNo">062</span>     *              should be the recipient's email address.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     * @param subject  The value of the &lt;code&gt;Subject:&lt;/code&gt; header field.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     *              This should be the subject of the message.<a name="line.64"></a>
<span class="sourceLineNo">065</span>     ***/<a name="line.65"></a>
<span class="sourceLineNo">066</span>    public SimpleSMTPHeader(String from, String to, String subject)<a name="line.66"></a>
<span class="sourceLineNo">067</span>    {<a name="line.67"></a>
<span class="sourceLineNo">068</span>        __to = to;<a name="line.68"></a>
<span class="sourceLineNo">069</span>        __from = from;<a name="line.69"></a>
<span class="sourceLineNo">070</span>        __subject = subject;<a name="line.70"></a>
<span class="sourceLineNo">071</span>        __headerFields = new StringBuffer();<a name="line.71"></a>
<span class="sourceLineNo">072</span>        __cc = null;<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    /***<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * Adds an arbitrary header field with the given value to the article<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * header.  These headers will be written before the From, To, Subject, and<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * Cc fields when the SimpleSMTPHeader is convertered to a string.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * An example use would be:<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * &lt;pre&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * header.addHeaderField("Organization", "Foobar, Inc.");<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * &lt;/pre&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * &lt;p&gt;<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @param headerField  The header field to add, not including the colon.<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @param value  The value of the added header field.<a name="line.85"></a>
<span class="sourceLineNo">086</span>     ***/<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public void addHeaderField(String headerField, String value)<a name="line.87"></a>
<span class="sourceLineNo">088</span>    {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        __headerFields.append(headerField);<a name="line.89"></a>
<span class="sourceLineNo">090</span>        __headerFields.append(": ");<a name="line.90"></a>
<span class="sourceLineNo">091</span>        __headerFields.append(value);<a name="line.91"></a>
<span class="sourceLineNo">092</span>        __headerFields.append('\n');<a name="line.92"></a>
<span class="sourceLineNo">093</span>    }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /***<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * Add an email address to the CC (carbon copy or courtesy copy) list.<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * &lt;p&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @param address The email address to add to the CC list.<a name="line.99"></a>
<span class="sourceLineNo">100</span>     ***/<a name="line.100"></a>
<span class="sourceLineNo">101</span>    public void addCC(String address)<a name="line.101"></a>
<span class="sourceLineNo">102</span>    {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        if (__cc == null) {<a name="line.103"></a>
<span class="sourceLineNo">104</span>            __cc = new StringBuffer();<a name="line.104"></a>
<span class="sourceLineNo">105</span>        } else {<a name="line.105"></a>
<span class="sourceLineNo">106</span>            __cc.append(", ");<a name="line.106"></a>
<span class="sourceLineNo">107</span>        }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>        __cc.append(address);<a name="line.109"></a>
<span class="sourceLineNo">110</span>    }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    /***<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * Converts the SimpleSMTPHeader to a properly formatted header in<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * the form of a String, including the blank line used to separate<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * the header from the article body.  The header fields CC and Subject<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * are only included when they are non-null.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * &lt;p&gt;<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @return The message header in the form of a String.<a name="line.119"></a>
<span class="sourceLineNo">120</span>     ***/<a name="line.120"></a>
<span class="sourceLineNo">121</span>    @Override<a name="line.121"></a>
<span class="sourceLineNo">122</span>    public String toString()<a name="line.122"></a>
<span class="sourceLineNo">123</span>    {<a name="line.123"></a>
<span class="sourceLineNo">124</span>        StringBuilder header = new StringBuilder();<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span>        if (__headerFields.length() &gt; 0) {<a name="line.126"></a>
<span class="sourceLineNo">127</span>            header.append(__headerFields.toString());<a name="line.127"></a>
<span class="sourceLineNo">128</span>        }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span>        header.append("From: ");<a name="line.130"></a>
<span class="sourceLineNo">131</span>        header.append(__from);<a name="line.131"></a>
<span class="sourceLineNo">132</span>        header.append("\nTo: ");<a name="line.132"></a>
<span class="sourceLineNo">133</span>        header.append(__to);<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>        if (__cc != null)<a name="line.135"></a>
<span class="sourceLineNo">136</span>        {<a name="line.136"></a>
<span class="sourceLineNo">137</span>            header.append("\nCc: ");<a name="line.137"></a>
<span class="sourceLineNo">138</span>            header.append(__cc.toString());<a name="line.138"></a>
<span class="sourceLineNo">139</span>        }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>        if (__subject != null)<a name="line.141"></a>
<span class="sourceLineNo">142</span>        {<a name="line.142"></a>
<span class="sourceLineNo">143</span>            header.append("\nSubject: ");<a name="line.143"></a>
<span class="sourceLineNo">144</span>            header.append(__subject);<a name="line.144"></a>
<span class="sourceLineNo">145</span>        }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>        header.append('\n');<a name="line.147"></a>
<span class="sourceLineNo">148</span>        header.append('\n');<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span>        return header.toString();<a name="line.150"></a>
<span class="sourceLineNo">151</span>    }<a name="line.151"></a>
<span class="sourceLineNo">152</span>}<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>




























































</pre>
</div>
</body>
</html>
